home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / memory & system tools / meminfo / meminfo.guide (.txt) < prev    next >
Amigaguide Document  |  1996-04-07  |  11KB  |  264 lines
  1. @database "MemInfo"
  2. @master "MemInfo.guide"
  3. @width 80
  4. @Remark $VER: MemInfo.guide 3.00 (24.05.94)
  5. @Remark AmigaGuide database for MemInfo
  6. @Node Main "MemInfo Documentation"
  7.     MemInfo v3.00
  8.     *************
  9.       Release date: 24-May-1994
  10.       
  11.       Copyright 
  12.  1994 Eivind Rovik
  13.       
  14.       Select from the following topics:
  15.          @{" Introduction "        Link "Introduction"}
  16.          @{" Requirements "        Link "Requirements"}
  17.          @{" Installation "        Link "Installation"}
  18.          @{" Usage from Workbench "    Link "Usage from Workbench"}
  19.          @{" Usage from CLI "        Link "Usage from CLI"}
  20.          @{" Copyright "        Link "Copyright"}
  21. @EndNode
  22. @Node "Introduction"
  23.  Introduction
  24.  ------------
  25.  This program was written to keep the average computer freak always
  26.  informed about time and space. And do it somehow realtime, in contradiction
  27.  to the workbench's very slow updating of the current 'free memory'.
  28.  With this new version there has been added a lot of new features. MemInfo
  29.  opens a window with only a window title that can be placed at the top of
  30.  the workbench screen as a substitute for the workbench info line.
  31.  All information is displayed on this titlebar in a very compact format.
  32.  You might think that you then will miss the workbench messages!
  33.  Well, not so!  MemInfo now also displays any workbench messagaes in
  34.  it's window!
  35.  Here are some of the features:
  36.     - Keeps you real time informed about memory allocation
  37.       (chip,fast,total)  Realtime updating of the size of all volumes
  38.       in the system.
  39.     - Display all sizes in some of these formats bytes, kb, mb, % free
  40.       and % used
  41.     - Display date and clock in all formats
  42.     - Proportinal spacing of the window to minimize display size.
  43.     - Custom setting of: Width, Update freq, Task Priority,
  44.       WB mess delay, Public screen
  45.     - Full menu control of all features
  46.     - Full CLI control of all features
  47.     - Callable from both Workbench and CLI
  48.     - Saving of all settings to prefsfile
  49.  You can also select different display formats like bytes,K,MB,%. MemInfo also
  50.  has a lot of other features. These can be saved in a config file and you can
  51.  change them from the CLI argument line or the menus. MemInfo can be started
  52.  from both the CLI and the workbench.
  53. @EndNode
  54. @Node "Requirements"
  55.  System Requirements
  56.  -------------------
  57.   - Kickstart v2.04 or higher
  58.   - Reqtools.library v37 or higher
  59. @EndNode
  60. @Node "Installation"
  61.  Installation
  62.  ------------
  63.   - Just move the MemInfo icon into the wbstartup drawer
  64.   - Put a string into the User-Startup
  65. @EndNode
  66. @Node "Usage from Workbench"
  67.  Usage from Workbench
  68.  --------------------
  69.  Double click the MemInfo icon or place it into the wbstartup drawer.
  70.  All settings can be set from the menus.
  71.  MENUS:
  72.  Project
  73.     Save Config    Save the configuration in ENVARC:MemInfo.prefs
  74.             This will save all your settings in the menus
  75.             and the x/y- position of the window.
  76.     About        Just a little note from the author
  77.     Quit        Exit, finito, chao, cherio, zip, nix, zero
  78.  Memory
  79.     Mem size:
  80.       Chip        Show free chip memory
  81.       Fast        Show free fast memory
  82.       Public    Show free public memory
  83.     Larges chunk:
  84.       Chip        Show largest chunk in chip memory
  85.       Fast        Show largest chunk in fast memory
  86.       Public    Show largest chunk in public memory
  87.     Mem #chunks:
  88.       Chip        Show number of chunks in chip memory
  89.       Fast        Show number of chunks in fast memory
  90.       Public    Show number of chunks in public memory
  91.  Mem Unit
  92.     Bytes        Show memory in bytes
  93.     KBytes        Show memory in KBytes
  94.     MBytes        Show memory in MBytes
  95.     % free        Show memory in % free
  96.     % used        Show memory in % used
  97.  Time    
  98.       Date        Show date
  99.       Clock        Show clock
  100.       Seconds    Show seconds
  101.     Format:
  102.       dd-mmm-yy    Show date in dd-mmm-yy
  103.       yy-mmm-dd    Show date in yy-mmm-dd
  104.       mm-dd-yy    Show date in mm-dd-yy
  105.       dd-mm-yy    Show date in dd-mm-yy
  106.  Volumes        Contains all volumes in system except RAM. It also
  107.             excludes any PCx drives. This is because of the
  108.             unstable nature of this device that leads to lock up
  109.             if it is called when it's active!
  110.  Vol Unit        
  111.     Bytes        Show volume size in bytes
  112.     KBytes        Show volume size in KBytes
  113.     MBytes        Show volume size in MBytes
  114.     % free        Show volume size in % free
  115.     % used        Show volume size in % used
  116.  Window
  117.     Width:
  118.       WB Clone    The width of the MemInfo window will be the same
  119.             as the Workbench Screenbar minus the screen
  120.             front/back gadget
  121.       Proportional    Turn on the proportional width mode. This will
  122.             keep the window resizing according to the current
  123.             information width of the window.
  124.       Custom    Custom window size
  125.     Other:
  126.       Always Front    This will always keep the MemInfo window in front of
  127.             all other windows
  128.       WB Mess    MemInfo will show all the workbench messages that
  129.             appears on the Workbench Screenbar. This option 
  130.             might not work with new versions of the workbench
  131.             we can only hope!
  132.       Fixed Columns    The memory free columns (chip,fast,public) will
  133.             not resize, but have a fixed width of approx.
  134.             7 characters. (I might remove this in the future!)
  135.       Close Gadget    Close gadget on/off
  136.       No Dragbar    Make the window non draggable
  137.       Right Offset    Calculate position relative to the right border
  138.     Width...    Set the width of the window
  139.     Update freq...    Update frequency in updates per seconds
  140.     Task Priority...Set task priority
  141.     WB mess delay...How long the MemInfo program should show the
  142.             Workbench message in seconds. If this is
  143.             zero, MemInfo will hold it until the workbench
  144.             itself removes the message (normally when you
  145.             click the mouse).
  146.     Public screen...Public screen name
  147. @EndNode
  148. @Node "Usage from CLI"
  149.  Usage from CLI
  150.  --------------
  151.  All settings can be set from the menus and saved in a config file, there
  152.  is really no need to use the CLI arguments. However for anyone who insist
  153.  here they are. You should also notice that the configfile is just a
  154.  completely normal argument line!
  155.  Indeed if there exists a config file, the arg line and the config file will
  156.  be combined, but the argline will override the configfile!
  157.  > run MemInfo
  158.  template:  X/K,Y/K,FRONT/S,CHIP=C/S,FAST=F/S,PUBLIC=P/S,CLOCK/S,DATE/S,
  159.         WIDTH=W/K,BYTE/S,KB/S,MB/S,NOWBMESS=NM/S,WBMESSDELAY=WD/K,
  160.         FIXEDCOL=FC/S,WBWIDTH=WW/S,CHIPLAR=CL/S,FASTLAR=FL/S,PUBLAR=PL/S,
  161.         CHIPNC=CN/S,FASTNC=FN/S,PUBNC=PN/S,PF/S,PU/S,SEC/S,TIMEDOS=TD/S,
  162.         TIMEINT=TI/S,TIMEUSA=TU/S,TIMECDN=TC/S,VUB/S,VUKB/S,VUMB/S,VUPF/S,
  163.         VUPU/S,CLOSE/S,TASKPRI/K,UPDATE/K,VOLUMES/M,PUBSCR/K,DAGBAR/S,
  164.         ROFFSET/S
  165.  <switches>:    Just type the switch string
  166.  CHIP=C/S    Remove column with available chip memory
  167.  FAST=F/S    Remove column with available fast memory
  168.  PUBLIC=P/S    Remove column with available public memory
  169.  CHIPLAR=CL/S    Insert column with largest chunk in chip memory
  170.  FASTLAR=FL/S    Insert column with largest chunk in fast memory
  171.  PUBLAR=PL/S    Insert column with largest chunk in public memory
  172.  CHIPNC=CN/S    Insert column with number of chunks in chip memory
  173.  FASTNC=FN/S    Insert column with number of chunks in fast memory
  174.  PUBNC=PN/S    Insert column with number of chunks in public memory
  175.  BYTE/S        Show memory free in bytes (default)
  176.  KB/S        Show memory free in KBytes
  177.  MB/S        Show memory free in MBytes
  178.  PF/S        Show memory free in % free
  179.  PU/S        Show memory free in % used
  180.  CLOCK/S    Remove column showing the time of day
  181.  DATE/S        Remove column showing the date
  182.  SEC/S        Remove seconds in the clock column
  183.  TIMEDOS=TD/S    Show date in dd-mmm-yy
  184.  TIMEINT=TI/S    Show date in yy-mmm-dd
  185.  TIMEUSA=TU/S    Show date in mm-dd-yy
  186.  TIMECDN=TC/S    Show date in dd-mm-yy
  187.  VUB/S        Show volumes free in bytes
  188.  VUKB/S        Show volumes free in KBytes
  189.  VUMB/S        Show volumes free in MBytes (default)
  190.  VUPF/S        Show volumes free in % free
  191.  VUPU/S        Show volumes free in % used
  192.  FRONT/S    This will always keep the MemInfo window in front of
  193.         all other windows
  194.  NOWBMESS=NM/S    MemInfo will not show any workbench message that appears
  195.         on the Workbench Screenbar
  196.  FIXEDCOL=FC/S    The memory free columns (chip,fast,public) will not
  197.         resize, but have a fixed width of approx. 7 characters
  198.  WBWIDTH=WW/S    The width of the MemInfo window will be the same as the
  199.         Workbench Screenbar minus the screen front/back gadget
  200.  CLOSE/S    Remove close gadget
  201.  DAGBAR/S    Make the window non draggable
  202.  ROFFSET/S    Calculate position relative to the right border
  203.  <keys>:    You type the keyword and then the string or number
  204.  X/K/N        X keyword followed by the x-position number
  205.  Y/K/N        Y keyword followed by the y-position number
  206.  WBMESSDELAY=WD/K/N
  207.         WBMESSDELAY or WD keyword followed by the workbench
  208.         message delay in seconds
  209.  WIDTH=W/K/N    Width or W keyword followed by the width of the window,
  210.         this will make the window nonproportional.
  211.  TASKPRI/K/N    TASKPRI folled by a number between -128 and 127 to set
  212.         the task priority
  213.  UPDATE/K/N    UPDATE followed by a number specifying update frequency
  214.         in updates per second
  215.  PUBSCR/K/N    PUBSCR followed by a public screen name
  216.  <other>:    What ever else is on the argument line
  217.  VOLUMES/M    All other arguments on the argument line will be interpeted
  218.         as an volume, RAM: and PCx: devices will not be displayed!
  219.         NOTE! These are really device names and they are case-sensitiv
  220.               that means always use capital letters (DH0 not dh0) and
  221.               no : marks!
  222. @EndNode
  223. @Node "Copyright"
  224.  Copyright
  225.  ---------
  226.  MemInfo is Copyright 
  227.  1994 by
  228.           Eivind Rovik
  229.           Varatunveien 57
  230.           4300 Sandnes
  231.           NORWAY
  232.          
  233.  InterNet:  rovik@hsr.no
  234.  I would be very greatful for any bug reports or
  235.  suggestions for improvement of MemInfo.
  236.  MemInfo v3.00 was released 24-May-1994 on aminet (ftp.luth.se)
  237.  Distribution conditions
  238.  -----------------------
  239.  This program may be distributed freely on the condition that
  240.  no profit is gained from its distribution.  An amount of the
  241.  average retail price of a single 3.5 inch DSDD disk is allowed for
  242.  a copying fee.
  243.  This doc file and the icons must accompany the program unmodified.
  244.  Disclaimer
  245.  ----------
  246.    THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
  247.  APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
  248.  HOLDER AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
  249.  WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
  250.  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  251.  PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE
  252.  OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU
  253.  ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
  254.    IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
  255.  WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY REDISTRIBUTE THE
  256.  PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
  257.  GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF
  258.  THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO
  259.  LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
  260.  YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY
  261.  OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF
  262.  THE POSSIBILITY OF SUCH DAMAGES.
  263. @EndNode
  264.